Skunkware 5

home *** CD-ROM | disk | FTP | other *** search

/ Skunkware 5 / Skunkware 5.iso / man / cat.1 / grefer.1 < prev next >

Wrap

Text File | 1995-07-25 | 56KB | 991 lines

GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) NNNNAAAAMMMMEEEE grefer - preprocess bibliographic references for groff SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS ggggrrrreeeeffffeeeerrrr [ ----bbbbeeeennnnvvvvCCCCPPPPRRRRSSSS ] [ ----aaaa_n ] [ ----cccc_f_i_e_l_d_s ] [ ----ffff_n ] [ ----iiii_f_i_e_l_d_s ] [ ----kkkk_f_i_e_l_d ] [ ----llll_m,_n ] [ ----pppp_f_i_l_e_n_a_m_e ] [ ----ssss_f_i_e_l_d_s ] [ ----tttt_n ] [ ----BBBB_f_i_e_l_d._m_a_c_r_o ] [ _f_i_l_e_n_a_m_e... ] DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN This file documents the GNU version of rrrreeeeffffeeeerrrr, which is part of the groff document formatting system. rrrreeeeffffeeeerrrr copies the contents of _f_i_l_e_n_a_m_e... to the standard output, except that lines between ....[[[[ and ....]]]] are interpreted as citations, and lines between ....RRRR1111 and ....RRRR2222 are interpreted as commands about how citations are to be processed. Each citation specifies a reference. The citation can specify a reference that is contained in a bibliographic database by giving a set of keywords that only that reference contains. Alternatively it can specify a reference by supplying a database record in the citation. A combination of these alternatives is also possible. For each citation, rrrreeeeffffeeeerrrr can produce a mark in the text. This mark consists of some label which can be separated from the text and from other labels in various ways. For each reference it also outputs ggggrrrrooooffffffff commands that can be used by a macro package to produce a formatted reference for each citation. The output of rrrreeeeffffeeeerrrr must therefore be processed using a suitable macro package. The ----mmmmssss and ----mmmmeeee macros are both suitable. The commands to format a citation's reference can be output immediately after the citation, or the references may be accumulated, and the commands output at some later point. If the references are accumulated, then multiple citations of the same reference will produce a single formatted reference. The interpretation of lines between ....RRRR1111 and ....RRRR2222 as commands is a new feature of GNU refer. Documents making use of this feature can still be processed by Unix refer just by adding the lines ....ddddeeee RRRR1111 ....iiiigggg RRRR2222 ........ to the beginning of the document. This will cause ttttrrrrooooffffffff to ignore everything between ....RRRR1111 and ....RRRR2222. The effect of some commands can also be achieved by options. These options are supported mainly for compatibility with Unix refer. It is usually more convenient to use commands. Page 1 (printed 3/9/94) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) rrrreeeeffffeeeerrrr generates ....llllffff lines so that filenames and line numbers in messages produced by commands that read rrrreeeeffffeeeerrrr output will be correct; it also interprets lines beginning with ....llllffff so that filenames and line numbers in the messages and ....llllffff lines that it produces will be accurate even if the input has been preprocessed by a command such as ggggssssooooeeeelllliiiimmmm(1). OOOOPPPPTTTTIIIIOOOONNNNSSSS Most options are equivalent to commands (for a description of these commands see the CCCCoooommmmmmmmaaaannnnddddssss subsection): ----bbbb nnnnoooo----llllaaaabbbbeeeellll----iiiinnnn----tttteeeexxxxtttt;;;; nnnnoooo----llllaaaabbbbeeeellll----iiiinnnn----rrrreeeeffffeeeerrrreeeennnncccceeee ----eeee aaaaccccccccuuuummmmuuuullllaaaatttteeee ----nnnn nnnnoooo----ddddeeeeffffaaaauuuulllltttt----ddddaaaattttaaaabbbbaaaasssseeee ----CCCC ccccoooommmmppppaaaattttiiiibbbblllleeee ----PPPP mmmmoooovvvveeee----ppppuuuunnnnccccttttuuuuaaaattttiiiioooonnnn ----SSSS llllaaaabbbbeeeellll """"((((AAAA....nnnn||||QQQQ)))) '''',,,, '''' ((((DDDD....yyyy||||DDDD))))"""";;;; bbbbrrrraaaacccckkkkeeeetttt----llllaaaabbbbeeeellll """" (((("""" )))) """";;;; """" ----aaaa_n rrrreeeevvvveeeerrrrsssseeee AAAA_n ----cccc_f_i_e_l_d_s ccccaaaappppiiiittttaaaalllliiiizzzzeeee _f_i_e_l_d_s ----ffff_n llllaaaabbbbeeeellll %%%%_n ----iiii_f_i_e_l_d_s sssseeeeaaaarrrrcccchhhh----iiiiggggnnnnoooorrrreeee _f_i_e_l_d_s ----kkkk llllaaaabbbbeeeellll LLLL%%%%aaaa ----kkkk_f_i_e_l_d llllaaaabbbbeeeellll _f_i_e_l_d%%%%aaaa ----llll llllaaaabbbbeeeellll AAAA....nnnnDDDD....yyyy%%%%aaaa ----llll_m llllaaaabbbbeeeellll AAAA....nnnn++++_mDDDD....yyyy%%%%aaaa ----llll,,,,_n llllaaaabbbbeeeellll AAAA....nnnnDDDD....yyyy----_n%%%%aaaa ----llll_m,,,,_n llllaaaabbbbeeeellll AAAA....nnnn++++_mDDDD....yyyy----_n%%%%aaaa ----pppp_f_i_l_e_n_a_m_e ddddaaaattttaaaabbbbaaaasssseeee _f_i_l_e_n_a_m_e ----ssss_s_p_e_c ssssoooorrrrtttt _s_p_e_c Page 2 (printed 3/9/94) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) ----tttt_n sssseeeeaaaarrrrcccchhhh----ttttrrrruuuunnnnccccaaaatttteeee _n These options are equivalent to the following commands with the addition that the filenames specified on the command line are processed as if they were arguments to the bbbbiiiibbbblllliiiiooooggggrrrraaaapppphhhhyyyy command instead of in the normal way: ----BBBB aaaannnnnnnnoooottttaaaatttteeee XXXX AAAAPPPP;;;; nnnnoooo----llllaaaabbbbeeeellll----iiiinnnn----rrrreeeeffffeeeerrrreeeennnncccceeee ----BBBB_f_i_e_l_d...._m_a_c_r_o aaaannnnnnnnoooottttaaaatttteeee _f_i_e_l_d _m_a_c_r_o;;;; nnnnoooo----llllaaaabbbbeeeellll----iiiinnnn----rrrreeeeffffeeeerrrreeeennnncccceeee The following options have no equivalent commands: ----vvvv Print the version number. ----RRRR Don't recognize lines beginning with ....RRRR1111/....RRRR2222. UUUUSSSSAAAAGGGGEEEE BBBBiiiibbbblllliiiiooooggggrrrraaaapppphhhhiiiicccc ddddaaaattttaaaabbbbaaaasssseeeessss The bibliographic database is a text file consisting of records separated by one or more blank lines. Within each record fields start with a %%%% at the beginning of a line. Each field has a one character name that immediately follows the %%%%. It is best to use only upper and lower case letters for the names of fields. The name of the field should be followed by exactly one space, and then by the contents of the field. Empty fields are ignored. The conventional meaning of each field is as follows: AAAA The name of an author. If the name contains a title such as JJJJrrrr.... at the end, it should be separated from the last name by a comma. There can be multiple occurrences of the AAAA field. The order is significant. It is a good idea always to supply an AAAA field or a QQQQ field. BBBB For an article that is part of a book, the title of the book CCCC The place (city) of publication. DDDD The date of publication. The year should be specified in full. If the month is specified, the name rather than the number of the month should be used, but only the first three letters are required. It is a good idea always to supply a DDDD field; if the date is unknown, a value such as iiiinnnn pppprrrreeeessssssss or uuuunnnnkkkknnnnoooowwwwnnnn can be used. EEEE For an article that is part of a book, the name of an editor of the book. Where the work has editors and no Page 3 (printed 3/9/94) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) authors, the names of the editors should be given as AAAA fields and ,,,, ((((eeeedddd)))) or ,,,, ((((eeeeddddssss)))) should be appended to the last author. GGGG US Government ordering number. IIII The publisher (issuer). JJJJ For an article in a journal, the name of the journal. KKKK Keywords to be used for searching. LLLL Label. NNNN Journal issue number. OOOO Other information. This is usually printed at the end of the reference. PPPP Page number. A range of pages can be specified as _m----_n. QQQQ The name of the author, if the author is not a person. This will only be used if there are no AAAA fields. There can only be one QQQQ field. RRRR Technical report number. SSSS Series name. TTTT Title. For an article in a book or journal, this should be the title of the article. VVVV Volume number of the journal or book. XXXX Annotation. For all fields except AAAA and EEEE, if there is more than one occurernce of a particular field in a record, only the last such field will be used. If accent strings are used, they should follow the character to be accented. This means that the AAAAMMMM macro must be used with the ----mmmmssss macros. Accent strings should not be quoted: use one \\\\ rather than two. CCCCiiiittttaaaattttiiiioooonnnnssss The format of a citation is ....[[[[_o_p_e_n_i_n_g-_t_e_x_t _f_l_a_g_s _k_e_y_w_o_r_d_s _f_i_e_l_d_s ....]]]]_c_l_o_s_i_n_g-_t_e_x_t Page 4 (printed 3/9/94) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) The _o_p_e_n_i_n_g-_t_e_x_t, _c_l_o_s_i_n_g-_t_e_x_t and _f_l_a_g_s components are optional. Only one of the _k_e_y_w_o_r_d_s and _f_i_e_l_d_s components need be specified. The _k_e_y_w_o_r_d_s component says to search the bibliographic databases for a reference that contains all the words in _k_e_y_w_o_r_d_s. It is an error if more than one reference if found. The _f_i_e_l_d_s components specifies additional fields to replace or supplement those specified in the reference. When references are being accumulated and the _k_e_y_w_o_r_d_s component is non-empty, then additional fields should be specified only on the first occasion that a particular reference is cited, and will apply to all citations of that reference. The _o_p_e_n_i_n_g-_t_e_x_t and _c_l_o_s_i_n_g-_t_e_x_t component specifies strings to be used to bracket the label instead of the strings specified in the bbbbrrrraaaacccckkkkeeeetttt----llllaaaabbbbeeeellll command. If either of these components is non-empty, the strings specified in the bbbbrrrraaaacccckkkkeeeetttt----llllaaaabbbbeeeellll command will not be used; this behaviour can be altered using the [[[[ and ]]]] flags. Note that leading and trailing spaces are significant for these components. The _f_l_a_g_s component is a list of non-alphanumeric characters each of which modifies the treatment of this particular citation. Unix refer will treat these flags as part of the keywords and so will ignore them since they are non- alphanumeric. The following flags are currently recognized: #### This says to use the label specified by the sssshhhhoooorrrrtttt----llllaaaabbbbeeeellll command, instead of that specified by the llllaaaabbbbeeeellll command. If no short label has been specified, the normal label will be used. Typically the short label is used with author-date labels and consists of only the date and possibly a disambiguating letter; the #### is supposed to be suggestive of a numeric type of label. [[[[ Precede _o_p_e_n_i_n_g-_t_e_x_t with the first string specified in the bbbbrrrraaaacccckkkkeeeetttt----llllaaaabbbbeeeellll command. ]]]] Follow _c_l_o_s_i_n_g-_t_e_x_t with the second string specified in the bbbbrrrraaaacccckkkkeeeetttt----llllaaaabbbbeeeellll command. One advantages of using the [[[[ and ]]]] flags rather than including the brackets in _o_p_e_n_i_n_g-_t_e_x_t and _c_l_o_s_i_n_g-_t_e_x_t is that you can change the style of bracket used in the document just by changing the bbbbrrrraaaacccckkkkeeeetttt----llllaaaabbbbeeeellll command. Another advantage is that sorting and merging of citations will not necessarily be inhibited if the flags are used. If a label is to be inserted into the text, it will be Page 5 (printed 3/9/94) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) attached to the line preceding the ....[[[[ line. If there is no such line, then an extra line will be inserted before the ....[[[[ line and a warning will be given. There is no special notation for making a citation to multiple references. Just use a sequence of citations, one for each reference. Don't put anything between the citations. The labels for all the citations will be attached to the line preceding the first citation. The labels may also be sorted or merged. See the description of the <<<<>>>> label expression, and of the ssssoooorrrrtttt----aaaaddddjjjjaaaacccceeeennnntttt----llllaaaabbbbeeeellllssss and aaaabbbbbbbbrrrreeeevvvviiiiaaaatttteeee----llllaaaabbbbeeeellll----rrrraaaannnnggggeeeessss command. A label will not be merged if its citation has a non-empty _o_p_e_n_i_n_g-_t_e_x_t or _c_l_o_s_i_n_g- _t_e_x_t. However, the labels for a citation using the ]]]] flag and without any _c_l_o_s_i_n_g-_t_e_x_t immediately followed by a citation using the [[[[ flag and without any _o_p_e_n_i_n_g-_t_e_x_t may be sorted and merged even though the first citation's _o_p_e_n_i_n_g-_t_e_x_t or the second citation's _c_l_o_s_i_n_g-_t_e_x_t is non- empty. (If you wish to prevent this just make the first citation's _c_l_o_s_i_n_g-_t_e_x_t \\\\&&&&.) CCCCoooommmmmmmmaaaannnnddddssss Commands are contained between lines starting with ....RRRR1111 and ....RRRR2222. Recognition of these lines can be prevented by the ----RRRR option. When a ....RRRR1111 line is recognized any accumulated references are flushed out. Neither ....RRRR1111 nor ....RRRR2222 lines, nor anything between them is output. Commands are separated by newlines or ;;;;s. #### introduces a comment that extends to the end of the line (but does not conceal the newline). Each command is broken up into words. Words are separated by spaces or tabs. A word that begins with """" extends to the next """" that is not followed by another """". If there is no such """" the word extends to the end of the line. Pairs of """" in a word beginning with """" collapse to a single """". Neither #### nor ;;;; are recognized inside """"s. A line can be continued by ending it with \\\\; this works everywhere except after a ####. Each command _n_a_m_e that is marked with * has an associated negative command nnnnoooo----_n_a_m_e that undoes the effect of _n_a_m_e. For example, the nnnnoooo----ssssoooorrrrtttt command specifies that references should not be sorted. The negative commands take no arguments. In the following description each argument must be a single word; _f_i_e_l_d is used for a single upper or lower case letter naming a field; _f_i_e_l_d_s is used for a sequence of such letters; _m and _n are used for a non-negative numbers; _s_t_r_i_n_g is used for an arbitrary string; _f_i_l_e_n_a_m_e is used for the name of a file. Page 6 (printed 3/9/94) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) aaaabbbbbbbbrrrreeeevvvviiiiaaaatttteeee* _f_i_e_l_d_s _s_t_r_i_n_g_1 _s_t_r_i_n_g_2 _s_t_r_i_n_g_3 _s_t_r_i_n_g_4 Abbreviate the first names of _f_i_e_l_d_s. An initial letter will be separated from another initial letter by _s_t_r_i_n_g_1, from the last name by _s_t_r_i_n_g_2, and from anything else (such as a vvvvoooonnnn or ddddeeee) by _s_t_r_i_n_g_3. These default to a period followed by a space. In a hyphenated first name, the initial of the first part of the name will be separated from the hyphen by _s_t_r_i_n_g_4; this defaults to a period. No attempt is made to handle any ambiguities that might result from abbreviation. Names are abbreviated before sorting and before label construction. aaaabbbbbbbbrrrreeeevvvviiiiaaaatttteeee----llllaaaabbbbeeeellll----rrrraaaannnnggggeeeessss* _s_t_r_i_n_g Three or more adjacent labels that refer to consecutive references will be abbreviated to a label consisting of the first label, followed by _s_t_r_i_n_g followed by the last label. This is mainly useful with numeric labels. If _s_t_r_i_n_g is omitted it defaults to ----. aaaaccccccccuuuummmmuuuullllaaaatttteeee* Accumulate references instead of writing out each reference as it is encountered. Accumulated references will be written out whenever a reference of the form ....[[[[ $$$$LLLLIIIISSSSTTTT$$$$ ....]]]] is encountered, after all input files hve been processed, and whenever ....RRRR1111 line is recognized. aaaannnnnnnnoooottttaaaatttteeee* _f_i_e_l_d _s_t_r_i_n_g _f_i_e_l_d is an annotation; print it at the end of the reference as a paragraph preceded by the line ...._s_t_r_i_n_g If _m_a_c_r_o is omitted it will default to AAAAPPPP; if _f_i_e_l_d is also omitted it will default to XXXX. Only one field Page 7 (printed 3/9/94) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) can be an annotation. aaaarrrrttttiiiicccclllleeeessss _s_t_r_i_n_g... _s_t_r_i_n_g... are definite or indefinite articles, and should be ignored at the beginning of TTTT fields when sorting. Initially, tttthhhheeee, aaaa and aaaannnn are recognized as articles. bbbbiiiibbbblllliiiiooooggggrrrraaaapppphhhhyyyy _f_i_l_e_n_a_m_e... Write out all the references contained in the bibliographic databases _f_i_l_e_n_a_m_e... bbbbrrrraaaacccckkkkeeeetttt----llllaaaabbbbeeeellll _s_t_r_i_n_g_1 _s_t_r_i_n_g_2 _s_t_r_i_n_g_3 In the text, bracket each label with _s_t_r_i_n_g_1 and _s_t_r_i_n_g_2. An occurrence of _s_t_r_i_n_g_2 immediately followed by _s_t_r_i_n_g_1 will be turned into _s_t_r_i_n_g_3. The default behaviour is bbbbrrrraaaacccckkkkeeeetttt----llllaaaabbbbeeeellll \\\\****(((([[[[.... \\\\****((((....]]]] """",,,, """" ccccaaaappppiiiittttaaaalllliiiizzzzeeee _f_i_e_l_d_s Convert _f_i_e_l_d_s to caps and small caps. ccccoooommmmppppaaaattttiiiibbbblllleeee* Recognize ....RRRR1111 and ....RRRR2222 even when followed by a character other than space or newline. ddddaaaattttaaaabbbbaaaasssseeee _f_i_l_e_n_a_m_e... Search the bibliographic databases _f_i_l_e_n_a_m_e... For each _f_i_l_e_n_a_m_e if an index _f_i_l_e_n_a_m_e....iiii created by ggggiiiinnnnddddxxxxbbbbiiiibbbb(1) exists, then it will be searched instead; each index can cover multiple databases. ddddaaaatttteeee----aaaassss----llllaaaabbbbeeeellll* _s_t_r_i_n_g _s_t_r_i_n_g is a label expression that specifies a string with which to replace the DDDD field after constructing the label. See the LLLLaaaabbbbeeeellll eeeexxxxpppprrrreeeessssssssiiiioooonnnnssss subsection for a description of label expressions. This command is useful if you do not want explicit labels in the reference list, but instead want to handle any necessary disambiguation by qualifying the date in some way. The label used in the text would typically be some combination of the author and date. In most cases you should also use the nnnnoooo----llllaaaabbbbeeeellll---- Page 8 (printed 3/9/94) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) iiiinnnn----rrrreeeeffffeeeerrrreeeennnncccceeee command. For example, ddddaaaatttteeee----aaaassss----llllaaaabbbbeeeellll DDDD....++++yyyyDDDD....yyyy%%%%aaaa****DDDD....----yyyy would attach a disambiguating letter to the year part of the DDDD field in the reference. ddddeeeeffffaaaauuuulllltttt----ddddaaaattttaaaabbbbaaaasssseeee* The default database should be searched. This is the default behaviour, so the negative version of this command is more useful. refer determines whether the default database should be searched on the first occasion that it needs to do a search. Thus a nnnnoooo---- ddddeeeeffffaaaauuuulllltttt----ddddaaaattttaaaabbbbaaaasssseeee command must be given before then, in order to be effective. ddddiiiissssccccaaaarrrrdddd* _f_i_e_l_d_s When the reference is read, _f_i_e_l_d_s should be discarded; no string definitions for _f_i_e_l_d_s will be output. Initially, _f_i_e_l_d_s are XXXXYYYYZZZZ. eeeetttt----aaaallll* _s_t_r_i_n_g _m _n Control use of eeeetttt aaaallll in the evaluation of @@@@ expressions in label expressions. If the number of authors needed to make the author sequence unambiguous is _u and the total number of authors is _t then the last _t-_u authors will be replaced by _s_t_r_i_n_g provided that _t-_u is not less than _m and _t is not less than _n. The default behaviour is eeeetttt----aaaallll """" eeeetttt aaaallll"""" 2222 3333 iiiinnnncccclllluuuuddddeeee _f_i_l_e_n_a_m_e Include _f_i_l_e_n_a_m_e and interpret the contents as commands. jjjjooooiiiinnnn----aaaauuuutttthhhhoooorrrrssss _s_t_r_i_n_g_1 _s_t_r_i_n_g_2 _s_t_r_i_n_g_3 This says how authors should be joined together. When there are exactly two authors, they will be joined with _s_t_r_i_n_g_1. When there are more than two authors, all but the last two will be joined with _s_t_r_i_n_g_2, and the last two authors will be joined with _s_t_r_i_n_g_3. If _s_t_r_i_n_g_3 is omitted, it will default Page 9 (printed 3/9/94) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) to _s_t_r_i_n_g_1; if _s_t_r_i_n_g_2 is also omitted it will also default to _s_t_r_i_n_g_1. For example, jjjjooooiiiinnnn----aaaauuuutttthhhhoooorrrrssss """" aaaannnndddd """" """",,,, """" """",,,, aaaannnndddd """" will restore the default method for joining authors. llllaaaabbbbeeeellll----iiiinnnn----rrrreeeeffffeeeerrrreeeennnncccceeee* When outputting the reference, define the string [[[[FFFF to be the reference's label. This is the default behaviour; so the negative version of this command is more useful. llllaaaabbbbeeeellll----iiiinnnn----tttteeeexxxxtttt* For each reference output a label in the text. The label will be separated from the surrounding text as described in the bbbbrrrraaaacccckkkkeeeetttt----llllaaaabbbbeeeellll command. This is the default behaviour; so the negative version of this command is more useful. llllaaaabbbbeeeellll _s_t_r_i_n_g _s_t_r_i_n_g is a label expression describing how to label each reference. sssseeeeppppaaaarrrraaaatttteeee----llllaaaabbbbeeeellll----sssseeeeccccoooonnnndddd----ppppaaaarrrrttttssss _s_t_r_i_n_g When merging two-part labels, separate the second part of the second label from the first label with _s_t_r_i_n_g. See the description of the <<<<>>>> label expression. mmmmoooovvvveeee----ppppuuuunnnnccccttttuuuuaaaattttiiiioooonnnn* In the text, move any punctuation at the end of line past the label. It is usually a good idea to give this command unless you are using superscripted numbers as labels. rrrreeeevvvveeeerrrrsssseeee* _s_t_r_i_n_g Reverse the fields whose names are in _s_t_r_i_n_g. Each field name can be followed by a number which says how many such fields should be reversed. If no number is given for a field, all such fields will be reversed. sssseeeeaaaarrrrcccchhhh----iiiiggggnnnnoooorrrreeee* _f_i_e_l_d_s While searching for keys in databases for which no index Page 10 (printed 3/9/94) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) exists, ignore the contents of _f_i_e_l_d_s. Initially, fields XXXXYYYYZZZZ are ignored. sssseeeeaaaarrrrcccchhhh----ttttrrrruuuunnnnccccaaaatttteeee* _n Only require the first _n characters of keys to be given. In effect when searching for a given key words in the database are truncated to the maximum of _n and the length of the key. Initially _n is 6. sssshhhhoooorrrrtttt----llllaaaabbbbeeeellll* _s_t_r_i_n_g _s_t_r_i_n_g is a label expression that specifies an alternative (usually shorter) style of label. This is used when the #### flag is given in the citation. When using author- date style labels, the identity of the author or authors is sometimes clear from the context, and so it may be desirable to omit the author or authors from the label. The sssshhhhoooorrrrtttt----llllaaaabbbbeeeellll command will typically be used to specify a label containing just a date and possibly a disambiguating letter. ssssoooorrrrtttt* _s_t_r_i_n_g Sort references according to ssssttttrrrriiiinnnngggg. References will automatically be accumulated. _s_t_r_i_n_g should be a list of field names, each followed by a number, indicating how many fields with the name should be used for sorting. ++++ can be used to indicate that all the fields with the name should be used. Also .... can be used to indicate the references should be sorted using the (tentative) label. (The LLLLaaaabbbbeeeellll eeeexxxxpppprrrreeeessssssssiiiioooonnnnssss subsection describes the concept of a tentative label.) ssssoooorrrrtttt----aaaaddddjjjjaaaacccceeeennnntttt----llllaaaabbbbeeeellllssss* Sort labels that are adjacent in the text according to their position in the reference list. This command should usually be given if the aaaabbbbbbbbrrrreeeevvvviiiiaaaatttteeee----llllaaaabbbbeeeellll---- rrrraaaannnnggggeeeessss command has been given, or if the label expression contains a <<<<>>>> expression. This will have no effect unless references are being accumulated. Page 11 (printed 3/9/94) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) LLLLaaaabbbbeeeellll eeeexxxxpppprrrreeeessssssssiiiioooonnnnssss Label expressions can be evaluated both normally and tentatively. The result of normal evaluation is used for output. The result of tentative evaluation, called the _t_e_n_t_a_t_i_v_e _l_a_b_e_l, is used to gather the information that normal evaluation needs to disambiguate the label. Label expressions specified by the ddddaaaatttteeee----aaaassss----llllaaaabbbbeeeellll and sssshhhhoooorrrrtttt----llllaaaabbbbeeeellll commands are not evaluated tentatively. Normal and tentative evaluation are the same for all types of expression other than @@@@, ****, and %%%% expressions. The description below applies to normal evaluation, except where otherwise specified. _f_i_e_l_d _f_i_e_l_d _n The _n-th part of _f_i_e_l_d. If _n is omitted, it defaults to 1. ''''_s_t_r_i_n_g'''' The characters in _s_t_r_i_n_g literally. @@@@ All the authors joined as specified by the jjjjooooiiiinnnn----aaaauuuutttthhhhoooorrrrssss command. The whole of each author's name will be used. However, if the references are sorted by author (that is the sort specification starts with AAAA++++), then authors' last names will be used instead, provided that this does not introduce ambiguity, and also an initial subsequence of the authors may be used instead of all the authors, again provided that this does not introduce ambiguity. The use of only the last name for the _i-th author of some reference is considered to be ambiguous if there is some other reference, such that the first _i-1 authors of the references are the same, the _i-th authors are not the same, but the _i-th authors' last names are the same. A proper initial subsequence of the sequence of authors for some reference is considered to be ambiguous if there is a reference with some other sequence of authors which also has that subsequence as a proper initial subsequence. When an initial subsequence of authors is used, the remaining authors are replaced by the string specified by the eeeetttt----aaaallll command; this command may also specify additional requirements that must be met before an initial subsequence can be used. @@@@ tentatively evaluates to a canonical representation of the authors, such that authors that compare equally for sorting purpose will have the same representation. %%%%_n %%%%aaaa %%%%AAAA %%%%iiii Page 12 (printed 3/9/94) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) %%%%IIII The serial number of the reference formatted according to the character following the %%%%. The serial number of a reference is 1 plus the number of earlier references with same tentative label as this reference. These expressions tentatively evaluate to an empty string. _e_x_p_r**** If there is another reference with the same tentative label as this reference, then _e_x_p_r, otherwise an empty string. It tentatively evaluates to an empty string. _e_x_p_r++++_n _e_x_p_r----_n The first (++++) or last (----) _n upper or lower case letters or digits of _e_x_p_r. Troff special characters (such as \\\\((((''''aaaa) count as a single letter. Accent strings are retained but do not count towards the total. _e_x_p_r....llll _e_x_p_r converted to lowercase. _e_x_p_r....uuuu _e_x_p_r converted to uppercase. _e_x_p_r....cccc _e_x_p_r converted to caps and small caps. _e_x_p_r....rrrr _e_x_p_r reversed so that the last name is first. _e_x_p_r....aaaa _e_x_p_r with first names abbreviated. Note that fields specified in the aaaabbbbbbbbrrrreeeevvvviiiiaaaatttteeee command are abbreviated before any labels are evaluated. Thus ....aaaa is useful only when you want a field to be abbreviated in a label but not in a reference. _e_x_p_r....yyyy The year part of _e_x_p_r. _e_x_p_r....++++yyyy The part of _e_x_p_r before the year, or the whole of _e_x_p_r if it does not contain a year. _e_x_p_r....----yyyy The part of _e_x_p_r after the year, or an empty string if _e_x_p_r does not contain a year. _e_x_p_r....nnnn The last name part of _e_x_p_r. _e_x_p_r_1 Page 13 (printed 3/9/94) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) _e_x_p_r_1 except that if the last character of _e_x_p_r_1 is ---- then it will be replaced by _e_x_p_r_2. _e_x_p_r_1 _e_x_p_r_2 The concatenation of _e_x_p_r_1 and _e_x_p_r_2. _e_x_p_r_1||||_e_x_p_r_2 If _e_x_p_r_1 is non-empty then _e_x_p_r_1 otherwise _e_x_p_r_2. _e_x_p_r_1&&&&_e_x_p_r_2 If _e_x_p_r_1 is non-empty then _e_x_p_r_2 otherwise an empty string. _e_x_p_r_1????_e_x_p_r_2::::_e_x_p_r_3 If _e_x_p_r_1 is non-empty then _e_x_p_r_2 otherwise _e_x_p_r_3. <<<<_e_x_p_r>>>> The label is in two parts, which are separated by _e_x_p_r. Two adjacent two-part labels which have the same first part will be merged by appending the second part of the second label onto the first label separated by the string specified in the sssseeeeppppaaaarrrraaaatttteeee----llllaaaabbbbeeeellll----sssseeeeccccoooonnnndddd----ppppaaaarrrrttttssss command (initially, a comma followed by a space); the resulting label will also be a two-part label with the same first part as before merging, and so additional labels can be merged into it. Note that it is permissible for the first part to be empty; this maybe desirable for expressions used in the sssshhhhoooorrrrtttt----llllaaaabbbbeeeellll command. ((((_e_x_p_r)))) The same as _e_x_p_r. Used for grouping. The above expressions are listed in order of precedence (highest first); &&&& and |||| have the same precedence. MMMMaaaaccccrrrroooo iiiinnnntttteeeerrrrffffaaaacccceeee Each reference starts with a call to the macro ]]]]----. The string [[[[FFFF will be defined to be the label for this reference, unless the nnnnoooo----llllaaaabbbbeeeellll----iiiinnnn----rrrreeeeffffeeeerrrreeeennnncccceeee command has been given. There then follows a series of string definitions, one for each field: string [[[[_X corresponds to field _X. The number register [[[[PPPP is set to 1 if the PPPP field contains a range of pages. The [[[[TTTT, [[[[AAAA and [[[[OOOO number registers are set to 1 according as the TTTT, AAAA and OOOO fields end with one of the characters ....????!!!!. The [[[[EEEE number register will be set to 1 if the [[[[EEEE string contains more than one name. The reference is followed by a call to the ]]]][[[[ macro. The first argument to this macro gives a number representing the type of the reference. If a reference contains a JJJJ field, it will be classified as type 1, otherwise if it contains a BBBB field, it will type 3, otherwise if it contains a GGGG or RRRR field it will Page 14 (printed 3/9/94) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((22224444 FFFFeeeebbbbrrrruuuuaaaarrrryyyy 1111999999994444)))) GGGGRRRREEEEFFFFEEEERRRR((((1111)))) be type 4, otherwise if contains a IIII field it will be type 2, otherwise it will be type 0. The second argument is a symbolic name for the type: ooootttthhhheeeerrrr, jjjjoooouuuurrrrnnnnaaaallll----aaaarrrrttttiiiicccclllleeee, bbbbooooooookkkk, aaaarrrrttttiiiicccclllleeee----iiiinnnn----bbbbooooooookkkk or tttteeeecccchhhh----rrrreeeeppppoooorrrrtttt. Groups of references that have been accumulated or are produced by the bbbbiiiibbbblllliiiiooooggggrrrraaaapppphhhhyyyy command are preceded by a call to the ]]]]<<<< macro and followed by a call to the ]]]]>>>> macro. FFFFIIIILLLLEEEESSSS ////uuuussssrrrr////ddddiiiicccctttt////ppppaaaappppeeeerrrrssss////IIIInnnndddd Default database. _f_i_l_e....iiii Index files. SSSSEEEEEEEE AAAALLLLSSSSOOOO ggggiiiinnnnddddxxxxbbbbiiiibbbb(1), ggggllllooooooookkkkbbbbiiiibbbb(1), llllkkkkbbbbiiiibbbb(1) BBBBUUUUGGGGSSSS In label expressions, <<<<>>>> expressions are ignored inside ...._c_h_a_r expressions. Page 15 (printed 3/9/94)